Eclipse Platform
Pre-release 3.0

org.eclipse.ui.progress
Class UIJob

java.lang.Object
  extended byorg.eclipse.core.runtime.PlatformObject
      extended byorg.eclipse.core.internal.jobs.InternalJob
          extended byorg.eclipse.core.runtime.jobs.Job
              extended byorg.eclipse.ui.progress.UIJob
All Implemented Interfaces:
Comparable, IAdaptable
Direct Known Subclasses:
WorkbenchJob

public abstract class UIJob
extends Job


Field Summary
 
Fields inherited from class org.eclipse.core.runtime.jobs.Job
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING
 
Fields inherited from class org.eclipse.core.internal.jobs.InternalJob
BLOCKED
 
Constructor Summary
UIJob(Display jobDisplay, String name)
          Create a new instance of the receiver with the supplied Display.
UIJob(String name)
          Create a new instance of the receiver with the supplied name.
 
Method Summary
static IStatus errorStatus(Throwable exception)
          Convenience method to return a status for an exception.
 Display getDisplay()
          Returns the display for use by the receiver.
 IStatus run(IProgressMonitor monitor)
          Executes the current job.
abstract  IStatus runInUIThread(IProgressMonitor monitor)
          Run the job in the UI Thread.
 void setDisplay(Display runDisplay)
          Sets the display to execute the asyncExec in.
 
Methods inherited from class org.eclipse.core.runtime.jobs.Job
addJobChangeListener, belongsTo, cancel, done, getName, getPriority, getResult, getRule, getState, getThread, isSystem, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setRule, setSystem, setThread, shouldRun, shouldSchedule, sleep, wakeUp
 
Methods inherited from class org.eclipse.core.internal.jobs.InternalJob
compareTo, toString
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

UIJob

public UIJob(String name)
Create a new instance of the receiver with the supplied name. The display used will be the one from the workbench if this is available. UIJobs with this constructor will determine thier display at runtime.

Parameters:
name - the job name

UIJob

public UIJob(Display jobDisplay,
             String name)
Create a new instance of the receiver with the supplied Display.

Parameters:
jobDisplay - the display
name - the job name
Method Detail

errorStatus

public static IStatus errorStatus(Throwable exception)
Convenience method to return a status for an exception.

Parameters:
exception -
Returns:
IStatus an error status built from the exception

run

public final IStatus run(IProgressMonitor monitor)
Description copied from class: Job
Executes the current job. Returns the result of the execution.

The provided monitor can be used to report progress and respond to cancellation. If the progress monitor has been cancelled, the job should finish its execution at the earliest convenience.

This method must not be called directly by clients. Clients should call schedule, which will in turn cause this method to be called.

Jobs can optionally finish their execution asynchronously (in another thread) by returning a result status of Job.ASYNC_FINISH. Jobs that finish asynchronously must indicate when they are finished by calling the method Job.done.

Specified by:
run in class Job
Parameters:
monitor - the monitor to be used for reporting progress, or null if progress monitoring is not required.
Returns:
the job result.
See Also:
Job.ASYNC_FINISH, Job.done(org.eclipse.core.runtime.IStatus)

runInUIThread

public abstract IStatus runInUIThread(IProgressMonitor monitor)
Run the job in the UI Thread.

Parameters:
monitor -
Returns:
IStatus

setDisplay

public void setDisplay(Display runDisplay)
Sets the display to execute the asyncExec in.

Parameters:
runDisplay - Display

getDisplay

public Display getDisplay()
Returns the display for use by the receiver.

Returns:
Display or null.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.